Skip to content
This repository was archived by the owner on Feb 25, 2025. It is now read-only.

Added a more complete docstring for SemanticsFlags #19817

Merged
merged 2 commits into from
Jul 16, 2020

Conversation

gaaclarke
Copy link
Member

Description

Related Issues

Tests

Checklist

Before you create this PR confirm that it meets all requirements listed below by checking the relevant checkboxes ([x]). This will ensure a smooth and quick review process.

  • I read the contributor guide and followed the process outlined there for submitting PRs.
  • I signed the CLA.
  • I read and followed the C++, Objective-C, Java style guides for the engine.
  • I read the tree hygiene wiki page, which explains my responsibilities.
  • I updated/added relevant documentation.
  • All existing and new tests are passing.
  • I am willing to follow-up on review comments in a timely manner.

Breaking Change

Did any tests fail when you ran them? Please read handling breaking changes.

@gaaclarke gaaclarke requested a review from chunhtai July 16, 2020 18:43
@auto-assign auto-assign bot requested a review from jason-simmons July 16, 2020 18:46
Copy link
Contributor

@chunhtai chunhtai left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

// Must match the SemanticsFlags enum in semantics.dart.
/// C/C++ representation of `SemanticsFlags` defined in
/// `lib/ui/semantics.dart`.
///\warning This must match the `SemanticsFlags` enum in
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

what does \ do ?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's doxygen commands which is what we use for c/c++/objc documentation: https://www.doxygen.nl/manual/commands.html

Comment on lines +11 to +16
///
/// \warning When changes are made to this class, the equivalent APIs in
/// `lib/ui/semantics/semantics_node.h` and in each of the embedders
/// *must* be updated.
/// See also:
/// - file://./../../lib/ui/semantics/semantics_node.h
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A couple of years later... #52229

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants